mpOpenAPI-4.0: implement validation #29687

Azquelt · 2024-09-20T11:03:01Z

I have considered the risk of behavior change or other zero migration impact (https://github.com/OpenLiberty/open-liberty/wiki/Behavior-Changes).
If this PR fixes an Issue, the description includes "Fixes #FILLMEIN" or "Resolves #FILLMEIN" (verify release bug label if applicable: https://github.com/OpenLiberty/open-liberty/wiki/Open-Liberty-Conventions).
If this PR resolves an external Known Issue (including APARS), the description includes "Fixes #FILLMEIN" or "Resolves #FILLMEIN".

LibbyBot · 2024-09-20T11:15:14Z

The following files contain a string indicating discriminating content:

dev/io.openliberty.microprofile.openapi.4.0.internal_fat/fat/src/io/openliberty/microprofile/openapi40/fat/validation/validation4.yml

So that they can be shared with MP OpenAPI 4.0 Also add a validation result matcher so we get better test failure messages.

Once the app has been deployed, we expect the messages to have been logged, so we don't need to wait for them. This has no effect if the test passes, but makes it run much more quickly if the expected messages are not emitted.

Azquelt · 2024-09-20T15:29:20Z

#libby

Azquelt · 2024-09-20T15:32:40Z

#build
#spawn.fullfat.buckets=com.ibm.ws.microprofile.openapi.1.1_fat_tck,com.ibm.ws.microprofile.openapi_fat,com.ibm.ws.microprofile.openapi_fat_tck,com.ibm.ws.openapi.ui_fat,io.openliberty.microprofile.openapi.2.0.internal_fat,io.openliberty.microprofile.openapi.2.0.internal_fat_tck,io.openliberty.microprofile.openapi.3.0.internal_fat_tck,io.openliberty.microprofile.openapi.3.1.internal_fat_tck,io.openliberty.microprofile.openapi.4.0.internal_fat,io.openliberty.microprofile.openapi.4.0.internal_fat_tck,io.openliberty.microprofile.openapi.ui.internal_fat

LibbyBot · 2024-09-20T15:32:49Z

Your personal pipeline request is at https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=15a75c78-d991-42a3-9ea1-23a141218539

Target locations of links might be accessible only to IBM employees.

Azquelt · 2024-09-20T15:33:09Z

The following files contain a string indicating discriminating content:

This should now be fixed.

LibbyBot · 2024-09-20T15:56:13Z

Your personal build request is at https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_erroUHdgEe-ZBdXWdK7Miw

Target locations of links might be accessible only to IBM employees.

LibbyBot · 2024-09-21T00:05:58Z

https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=15a75c78-d991-42a3-9ea1-23a141218539 has errors/failures.

LibbyBot · 2024-09-21T08:13:21Z

The build Azquelt-29687-20240920-1602
https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_erroUHdgEe-ZBdXWdK7Miw
completed and has errors or failures.

For help analyzing your personal build, go to https://libh-proxy1.fyre.ibm.com/cognitive/buildAnalysis.html?uuid=_erroUHdgEe-ZBdXWdK7Miw

Azquelt · 2024-09-22T22:24:34Z

Fixed OSGi services not present during unit testing.

#build
#spawn.fullfat.buckets=com.ibm.ws.microprofile.openapi.1.1_fat_tck,com.ibm.ws.microprofile.openapi_fat,com.ibm.ws.microprofile.openapi_fat_tck,com.ibm.ws.openapi.ui_fat,io.openliberty.microprofile.openapi.2.0.internal_fat,io.openliberty.microprofile.openapi.2.0.internal_fat_tck,io.openliberty.microprofile.openapi.3.0.internal_fat_tck,io.openliberty.microprofile.openapi.3.1.internal_fat_tck,io.openliberty.microprofile.openapi.4.0.internal_fat,io.openliberty.microprofile.openapi.4.0.internal_fat_tck,io.openliberty.microprofile.openapi.ui.internal_fat

LibbyBot · 2024-09-22T22:24:45Z

Your personal pipeline request is at https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=b76f7cb8-b4b8-4e5f-b414-607fa2d10600

Target locations of links might be accessible only to IBM employees.

LibbyBot · 2024-09-22T22:25:17Z

Your personal build request is at https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_KWRkwHkpEe-PXJdaQbhamQ

Target locations of links might be accessible only to IBM employees.

LibbyBot · 2024-09-23T07:26:39Z

https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=b76f7cb8-b4b8-4e5f-b414-607fa2d10600 has errors/failures.

Azquelt · 2024-09-23T08:33:53Z

Personal build looks good
#libby

LibbyBot · 2024-09-23T15:50:05Z

The build Azquelt-29687-20240922-1533
https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_KWRkwHkpEe-PXJdaQbhamQ
completed successfully!

helyarp

Suggested a minor change

helyarp · 2024-09-23T17:21:08Z

...o/openliberty/microprofile/openapi/internal/resources/validation/ValidationMessages.nlsprops

+schemaPropertyEmptyArray=The \"{0}\" property of the Schema Object is an empty array
+schemaPropertyNotUnique=The elements of the \"{0}\" property of the Schema Object are not unique
+schemaInvalidType=The \"type\" property of the Schema Object must only contain values which are one of (\"null\", \"boolean\", \"object\", \"array\", \"number\", \"integer\", \"string\")
+schemaCollectionElementWrongType=The \"{0}\" property of the Schema Object contains a value which is not of type \"{1}\"


Replace "which" with "that" or add a comma before "which"

is273 · 2024-09-20T20:09:17Z

...o/openliberty/microprofile/openapi/internal/resources/validation/ValidationMessages.nlsprops

@@ -64,6 +64,8 @@ nullValueInMap=The map specifies an invalid value for the \"{0}\" key. A map sho

 openAPIVersionInvalid=The OpenAPI Object must contain a valid OpenAPI specification version. The \"{0}\" value specified for the OpenAPI specification version is not valid
 openAPITagIsNotUnique=The OpenAPI Object must contain unique tag names. The \"{0}\" tag name is not unique
+#3.1
+openAPIMissingRequiredFields=The OpenAPI Object must contain at least one of the \"paths\", \"components\" or \"webhooks\" properties


The OpenAPI Object must contain at least one of the "paths", "components", or "webhooks" properties

is273 · 2024-09-20T20:10:19Z

...o/openliberty/microprofile/openapi/internal/resources/validation/ValidationMessages.nlsprops

@@ -112,9 +115,21 @@ schemaMultipleOfNotGreaterThanZero=The Schema Object must have the \"multipleOf\
 schemaPropertyLessThanZero=The \"{0}\" property of the Schema Object must be greater than or equal to zero
 schemaTypeDoesNotMatchProperty=The \"{0}\" property is not appropriate for the Schema Object of \"{1}\" type

+#3.1
+schemaPropertyWrongType=The \"{0}\" property of the Schema Object must be of type \"{1}\"


The "{0}" property of the Schema Object must be a "{1}" type

Is this still ok if the {1} variable starts with a vowel?

The values used for {1} in the code at the moment are "string", "number", "integer", "array", "object", "boolean", and "schema"

We decided on The type of the "{0}" property of the Schema Object must be "{1}"

is273 · 2024-09-20T20:11:02Z

...o/openliberty/microprofile/openapi/internal/resources/validation/ValidationMessages.nlsprops

+schemaPropertyWrongType=The \"{0}\" property of the Schema Object must be of type \"{1}\"
+schemaPropertyEmptyArray=The \"{0}\" property of the Schema Object is an empty array
+schemaPropertyNotUnique=The elements of the \"{0}\" property of the Schema Object are not unique
+schemaInvalidType=The \"type\" property of the Schema Object must only contain values which are one of (\"null\", \"boolean\", \"object\", \"array\", \"number\", \"integer\", \"string\")


The "type" property of the Schema Object must contain values that are one of ("null", "boolean", "object", "array", "number", "integer", or "string")

is273 · 2024-09-20T20:11:23Z

...o/openliberty/microprofile/openapi/internal/resources/validation/ValidationMessages.nlsprops

+schemaPropertyEmptyArray=The \"{0}\" property of the Schema Object is an empty array
+schemaPropertyNotUnique=The elements of the \"{0}\" property of the Schema Object are not unique
+schemaInvalidType=The \"type\" property of the Schema Object must only contain values which are one of (\"null\", \"boolean\", \"object\", \"array\", \"number\", \"integer\", \"string\")
+schemaCollectionElementWrongType=The \"{0}\" property of the Schema Object contains a value which is not of type \"{1}\"


The "{0}" property of the Schema Object contains a value that is not a "{1}" type

{1} may start with a vowel here too (same question as the above comment)

We decided on The "{0}" property of the Schema Object contains a value whose type is not "{1}"

Azquelt · 2024-09-24T16:02:50Z

Message review changes made.

#libby
#build
#spawn.fullfat.buckets=com.ibm.ws.microprofile.openapi.1.1_fat_tck,com.ibm.ws.microprofile.openapi_fat,com.ibm.ws.microprofile.openapi_fat_tck,com.ibm.ws.openapi.ui_fat,io.openliberty.microprofile.openapi.2.0.internal_fat,io.openliberty.microprofile.openapi.2.0.internal_fat_tck,io.openliberty.microprofile.openapi.3.0.internal_fat_tck,io.openliberty.microprofile.openapi.3.1.internal_fat_tck,io.openliberty.microprofile.openapi.4.0.internal_fat,io.openliberty.microprofile.openapi.4.0.internal_fat_tck,io.openliberty.microprofile.openapi.ui.internal_fat

LibbyBot · 2024-09-24T16:03:05Z

Your personal pipeline request is at https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=9638a01a-167d-443e-8f36-da4b64a9f7e8

Target locations of links might be accessible only to IBM employees.

is273

LGTM

LibbyBot · 2024-09-24T16:18:11Z

https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=9638a01a-167d-443e-8f36-da4b64a9f7e8 has errors/failures.

Azquelt · 2024-09-24T16:18:37Z

Missed a message change so need to re-request the build

#build
#spawn.fullfat.buckets=com.ibm.ws.microprofile.openapi.1.1_fat_tck,com.ibm.ws.microprofile.openapi_fat,com.ibm.ws.microprofile.openapi_fat_tck,com.ibm.ws.openapi.ui_fat,io.openliberty.microprofile.openapi.2.0.internal_fat,io.openliberty.microprofile.openapi.2.0.internal_fat_tck,io.openliberty.microprofile.openapi.3.0.internal_fat_tck,io.openliberty.microprofile.openapi.3.1.internal_fat_tck,io.openliberty.microprofile.openapi.4.0.internal_fat,io.openliberty.microprofile.openapi.4.0.internal_fat_tck,io.openliberty.microprofile.openapi.ui.internal_fat

LibbyBot · 2024-09-24T16:18:49Z

Your personal pipeline request is at https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=04dbecd8-f26b-4e88-8a22-08b4df7be45e

Target locations of links might be accessible only to IBM employees.

LibbyBot · 2024-09-24T19:15:17Z

Your personal build request is at https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_85VRoHqgEe-PXJdaQbhamQ

Target locations of links might be accessible only to IBM employees.

LibbyBot · 2024-09-24T19:36:14Z

Your personal build request is at https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_4QaeYHqjEe-PXJdaQbhamQ

Target locations of links might be accessible only to IBM employees.

LibbyBot · 2024-09-25T01:23:08Z

https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=04dbecd8-f26b-4e88-8a22-08b4df7be45e has errors/failures.

Azquelt · 2024-09-25T08:39:10Z

Personal build looks good

LibbyBot · 2024-09-25T14:48:43Z

The build Azquelt-29687-20240924-1921
https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_85VRoHqgEe-PXJdaQbhamQ
completed successfully!

...pi_fat/fat/src/com/ibm/ws/microprofile/openapi/validation/fat/OpenAPIValidationTestFive.java

yasmin-aumeeruddy · 2024-09-25T15:09:16Z

...internal/src/io/openliberty/microprofile/openapi20/internal/validation/ExampleValidator.java

Copyright header date needs updating

yasmin-aumeeruddy · 2024-09-25T15:09:28Z

....internal/src/io/openliberty/microprofile/openapi20/internal/validation/HeaderValidator.java

Copyright header date needs updating

yasmin-aumeeruddy · 2024-09-25T15:09:38Z

....0.internal/src/io/openliberty/microprofile/openapi20/internal/validation/LinkValidator.java

Copyright header date needs updating

yasmin-aumeeruddy · 2024-09-25T15:10:10Z

...ternal/src/io/openliberty/microprofile/openapi20/internal/validation/ParameterValidator.java

Copyright header date needs updating

...l_test/src/io/openliberty/microprofile/openapi20/test/utils/TestValidationContextHelper.java

yasmin-aumeeruddy · 2024-09-25T15:12:06Z

...nal_test/src/io/openliberty/microprofile/openapi20/validation/test/OpenAPIValidatorTest.java

Copyright header date needs updating

yasmin-aumeeruddy · 2024-09-25T15:12:18Z

...l_test/src/io/openliberty/microprofile/openapi20/validation/test/OperationValidatorTest.java

Copyright header date needs updating

yasmin-aumeeruddy · 2024-09-25T15:21:09Z

dev/io.openliberty.microprofile.openapi.4.0.internal_fat/bnd.bnd

Copyright header date needs updating

LibbyBot · 2024-09-25T15:25:02Z

The build Azquelt-29687-20240924-1942
https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_4QaeYHqjEe-PXJdaQbhamQ
completed successfully!

OpenAPI 3.1 is fairly similar to 3.0, so we re-use a lot of the same validation logic. As well as adding the new rules, we needed to: - refactor reference validation, as references need to be validated differently - Change how we select which validator to use so that its based on the OpenAPI version specified in the document rather than on which version of the feature is running (ensuring mpOpenAPI-4.0 can still validate OpenAPI v3.0 documents if the user has requested that) - Make the 3.0 Schema validation code work with the mpOpenAPI-4.0 data model which has breaking API changes. The 3.0 validation needs to work with all versions of the model.

We were testing for each of the problem messages we expect, but we weren't testing for the top message which says "The following errors were found:"

Copy the existing OpenAPI v3.0 validation FAT tests and adjust them for the new validation rules in v3.1 and run them against OpenAPI v3.1 documents.

Azquelt · 2024-09-26T09:15:50Z

Squashed the message reviews and updated the copyright headers.

#libby
#build

LibbyBot · 2024-09-26T09:16:09Z

Your personal pipeline request is at https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=a8a6ff16-6dac-44fb-924f-db293b95e6b9

Target locations of links might be accessible only to IBM employees.

LibbyBot · 2024-09-26T13:55:14Z

Your personal build request is at https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_kjdLQHwGEe-PXJdaQbhamQ

Target locations of links might be accessible only to IBM employees.

LibbyBot · 2024-09-26T13:55:17Z

Code analysis and actions

DO NOT DELETE THIS COMMENT.

38 product code files were changed.
Please describe in a separate comment how you tested your changes.
29 FAT files were changed, added, or removed.
Check that the build did not break the affected FAT suite(s).
38 unit test files were changed.
Check that the build did not break the affected unit test suite(s).
1 messages files were changed and need an L2 review.
@OpenLiberty/message-reviewer Please review.
dev/io.openliberty.microprofile.openapi.internal.common/resources/io/openliberty/microprofile/openapi/internal/resources/validation/ValidationMessages.nlsprops
1 NLS files were changed and need an ID review.
@OpenLiberty/message-reviewer Please review.
dev/io.openliberty.microprofile.openapi.internal.common/resources/io/openliberty/microprofile/openapi/internal/resources/validation/ValidationMessages.nlsprops

LibbyBot · 2024-09-26T21:31:47Z

https://libh-proxy1.fyre.ibm.com/cognitive/pipelineAnalysis.html?uuid=a8a6ff16-6dac-44fb-924f-db293b95e6b9 has errors/failures.

LibbyBot · 2024-09-27T08:23:18Z

The build Azquelt-29687-20240926-0704
https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_kjdLQHwGEe-PXJdaQbhamQ
completed and has errors or failures.

For help analyzing your personal build, go to https://libh-proxy1.fyre.ibm.com/cognitive/buildAnalysis.html?uuid=_kjdLQHwGEe-PXJdaQbhamQ

Azquelt · 2024-09-27T10:20:52Z

Errors in the build do not appear to related to this change.

LibbyBot added the CLA Signed label Sep 20, 2024

Azquelt force-pushed the mpopenapi-40-validation branch 2 times, most recently from 080a2fd to d240017 Compare September 20, 2024 12:56

Azquelt added 3 commits September 20, 2024 15:48

Move OpenAPI validation unit tests

e07ca42

So that they can be shared with MP OpenAPI 4.0 Also add a validation result matcher so we get better test failure messages.

Make existing OpenAPI validation FATs fail faster

338bf2d

Once the app has been deployed, we expect the messages to have been logged, so we don't need to wait for them. This has no effect if the test passes, but makes it run much more quickly if the expected messages are not emitted.

Fix location tracking in OpenAPI31ModelWalker

0f1fa31

Azquelt force-pushed the mpopenapi-40-validation branch 2 times, most recently from 0b57e23 to ae9f366 Compare September 20, 2024 15:12

Azquelt force-pushed the mpopenapi-40-validation branch from ae9f366 to db07f5b Compare September 20, 2024 16:34

Azquelt force-pushed the mpopenapi-40-validation branch from db07f5b to 59c2c01 Compare September 22, 2024 22:21

Azquelt force-pushed the mpopenapi-40-validation branch from 59c2c01 to f796d67 Compare September 22, 2024 22:25

helyarp reviewed Sep 23, 2024

View reviewed changes

is273 reviewed Sep 24, 2024

View reviewed changes

Azquelt force-pushed the mpopenapi-40-validation branch from e648ac2 to 6c6f01a Compare September 24, 2024 16:02

is273 reviewed Sep 24, 2024

View reviewed changes

is273 added the ID reviewed label Sep 24, 2024

yasmin-aumeeruddy previously approved these changes Sep 25, 2024

View reviewed changes

Azquelt mentioned this pull request Sep 26, 2024

OpenAPI FAT copyright headers missing #29733

Open

Azquelt dismissed yasmin-aumeeruddy’s stale review via 26bdb85 September 26, 2024 09:12

Azquelt added 5 commits September 26, 2024 10:14

Repeat OpenAPI 3.0 validation FAT on mpOpenAPI 4.0

a2d1723

MP OpenAPI: Add test for validation message output

feb0a48

We were testing for each of the problem messages we expect, but we weren't testing for the top message which says "The following errors were found:"

mpOpenAPI-4.0: OpenAPI v3.1 validation FAT tests

a0a56f0

Copy the existing OpenAPI v3.0 validation FAT tests and adjust them for the new validation rules in v3.1 and run them against OpenAPI v3.1 documents.

mpOpenAPI: update missed copyright headers

912b38a

Azquelt force-pushed the mpopenapi-40-validation branch from 26bdb85 to 912b38a Compare September 26, 2024 09:15

yasmin-aumeeruddy approved these changes Sep 26, 2024

View reviewed changes

Azquelt merged commit 8fb1a3f into OpenLiberty:integration Sep 27, 2024
2 of 3 checks passed

Azquelt deleted the mpopenapi-40-validation branch September 27, 2024 10:21

mpOpenAPI-4.0: implement validation #29687

mpOpenAPI-4.0: implement validation #29687

Conversation

Azquelt commented Sep 20, 2024

LibbyBot commented Sep 20, 2024

Azquelt commented Sep 20, 2024

Azquelt commented Sep 20, 2024

LibbyBot commented Sep 20, 2024

Azquelt commented Sep 20, 2024

LibbyBot commented Sep 20, 2024

LibbyBot commented Sep 21, 2024

LibbyBot commented Sep 21, 2024

Azquelt commented Sep 22, 2024

LibbyBot commented Sep 22, 2024

LibbyBot commented Sep 22, 2024

LibbyBot commented Sep 23, 2024

Azquelt commented Sep 23, 2024

LibbyBot commented Sep 23, 2024

helyarp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Azquelt commented Sep 24, 2024

LibbyBot commented Sep 24, 2024

is273 left a comment

Choose a reason for hiding this comment

LibbyBot commented Sep 24, 2024

Azquelt commented Sep 24, 2024

LibbyBot commented Sep 24, 2024

LibbyBot commented Sep 24, 2024

LibbyBot commented Sep 24, 2024

LibbyBot commented Sep 25, 2024

Azquelt commented Sep 25, 2024

LibbyBot commented Sep 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LibbyBot commented Sep 25, 2024

Azquelt commented Sep 26, 2024

LibbyBot commented Sep 26, 2024

LibbyBot commented Sep 26, 2024

LibbyBot commented Sep 26, 2024

Code analysis and actions

LibbyBot commented Sep 26, 2024

LibbyBot commented Sep 27, 2024

Azquelt commented Sep 27, 2024